hsl20_4_http_server.hsl20_4_http_server.Server Klassenreferenz

Alle Methoden des HTTP-Servers. Mehr ...

Öffentliche Methoden
def	__init__ (self, framework, context_map)
	Konstruktor. Mehr ...
def	set_authentication (self, user=None, pw=None, digest=False)
	Setzt die HTTP-Authentifizierung: Mehr ...
def	set_address (self, ip, port)
	Setzt die IP-Adresse und den IP-Port. Mehr ...
def	set_error_callback (self, callback)
	Setzt eine Callback-Methode für den Fehlerfall. Mehr ...
def	set_max_post_size (self, size)
	Setzt die zulässige Größe des Body für POST/PUT-Aufrufe. Mehr ...
def	set_logger (self, logger)
	Weist dem Server eine hsl20_4.hsl20_4.Logger Instanz zu. Mehr ...
def	start_server (self)
	Startet den Server. Mehr ...
def	register_uri (self, method, path, callback)
	Registriert eine URI am Server. Mehr ...
def	set_server_name (self, name)
	Setzt den Server-Name. Mehr ...

Ausführliche Beschreibung

Alle Methoden des HTTP-Servers.

Veraltet:

Diese Klasse sollte nicht mehr eingesetzt werden.

Bietet einen Server-Dienst zur Kommunikation per HTTP.

Wurde der HTTP-Server vom Framework erzeugt und an eine IP und einen Port gebunden, kann dieser gestartet werden.
Erfolgen nun Aufrufe durch einen Client, gibt es zwei Möglichkeiten:

• Der Client ruft eine registrierte URL auf: Der Server ruft im Kontext des Bausteins mit der Methode register_uri die entsprechende Callback-Methode mit den Parametern request und response auf.
  Die Methode kann nun auf die Anfrage reagieren und im response-Objekt darauf antworten.
  
• Der Client ruft eine unbekannte URL auf: Der Server ruft, sofern mit set_error_callback zugewiesen, das Error-Callback auf. Wurde kein Callback zugewiesen, antwortet der Server mit dem Statuscode 404 auf die Anfrage.

Nach Abarbeitung der jeweiligen Callback-Methode sendet der Server die erzeugte Antwort an die Gegenstelle. Wird im response-Objekt kein Statuscode gesetzt, antwortet der Server mit Statuscode 501.

Zu beachten

Die Klasse arbeitet asynchron. Keine der angebotenen Methoden blockiert.

HTTP-Request-Methoden

Bei der Registrierung einer URI können direkt eine oder mehrere HTTP-Methoden (per logischem ODER, z.B. hsl20_4_http_server.GET|hsl20_4_http_server.PUT) definiert werden, alternativ kann man auch hsl20_4_http_server.ALL zuweisen, dann wird die Callback-Methode bei jeder Methode aufgerufen. Der HTTP-Server bietet direkte Unterstützung für die folgenden Methoden:

• GET
• POST
• PUT
• DELETE

Bei den Methoden POST und PUT wird ein Body-Element im Request unterstützt, hierfür muss im Header das Feld "Content-length" gesetzt sein. Sollte der Client die maximal zulässige Größe überschreiten, wird die Verbindung durch den Server getrennt.
Siehe auch hsl20_4_http_server.Server::set_max_post_size

Timeouts

Folgende Timeouts, bei deren Eintreten die Verbindung getrennt wird, sind zu beachten:

• Der Zeitraum zwischen zwei gesendeten Paketen ist größer als 15 Sekunden
• Seit Aufbau der Verbindung sind mehr als 30 Sekunden vergangen und der Header wurde noch nicht korrekt gesendet

Authentifizierung

Es besteht die Möglichkeit, die Zugriffe auf den Server mit Benutzer/Passwort zu sichern. Über die Methode hsl20_4_http_server.Server.set_authentication kann die Authentifizierung aktiviert und deaktiviert werden. Zur Übermittlung der Benutzerdaten stehen folgende zwei Varianten zur Verfügung:

• "Basic Authentication"
  Der Client schickt Benutzername und Passwort base64 kodiert an den Server.
  
  "Algorithmus zur Erzeugung des zu übertragenden Werts:"

  RESULT = BASE64(Benutzername + ":" + Passwort)
  

  
  
• "Digest Access Authentication"
  Der Client sendet anstelle des Passworts einen Hashwert an den Server. Um diesen Hashwert zu ermitteln, erhält er vom Server einen Zufallsstring (NONCE_SERVER). Das Framework erfordert hierbei als Hash-Algorithmus "MD5", desweiteren die QOP-Variante "auth" (QOP = (Q)uality (o)f (p)rotection). Dies wiederum erfordert Client-seitig die Erzeugung eines Zufallswerts (NONCE_CLIENT) und einen Zähler (NONCE_COUNTER).
  
  "Algorithmus zur Erzeugung des Hashwerts:"

HA1 = MD5(BENUTZERNAME + ":" + REALM + ":" + PASSWORT) HA2 = MD5(UPPERCASE(HTTP_METHODE) + ":" + URI) RESULT = MD5(HA1 + ":" + NONCE_SERVER + ":" + NONCE_COUNTER + ":" + NONCE_CLIENT + ":auth:" + HA2)

Zu beachten

Es wird nur ein Benutzer/Passwort unterstützt.

Wird die Authentifizierung aktiviert, betrifft dies alle Zugriffe (Pfade) auf den Server.

Code-Beispiel

Die Verwendung dieser Klasse anhand eines kurzen Quellcode-Ausschnitts:

class mein_demo_modul(hsl20.BaseModule):

  ...

  def start_my_server(self):
      if self.server == None:
          self.server = self.FRAMEWORK.create_http_server()
          self.server.set_address("", 8080)
          self.server.set_authentication("user", "pw", 1)
          self.server.register_uri(hsl20_4_http_server.GET, "/", self.on_index_page)
          self.server.start_server()

  def on_index_page(self, request, response):
      if request.get_method() == "GET":
          response.set_status_code(200)
          response.set_header("Content-type", "text/html")
          response.set_body("<html><body>Hello World!</body></html>")

Beschreibung der Konstruktoren und Destruktoren

__init__()

def hsl20_4_http_server.hsl20_4_http_server.Server.__init__	(		self,
			framework,
			context_map
	)

Konstruktor.

Warnung

Diese Klasse sollte nicht direkt instanziert werden.

Dokumentation der Elementfunktionen

register_uri()

def hsl20_4_http_server.hsl20_4_http_server.Server.register_uri	(		self,
			method,
			path,
			callback
	)

Registriert eine URI am Server.

Wird diese URI von einem Client aufgerufen, wird das übergebene Callback ausgeführt.

Parameter

method	int HTTP-Abrufmethoden. Es werden per ODER mehrere Optionen pro URI unterstützt. Es stehen folgende Konstanten zur Verfügung: hsl20.framework.http_server.GET hsl20.framework.http_server.POST hsl20.framework.http_server.PUT hsl20.framework.http_server.DELETE hsl20.framework.http_server.ALL
path	string Pfad (z.B.: /index)
callback	function Callback. Die hier übergebene Methode benötigt folgende Parameter: request response

set_address()

def hsl20_4_http_server.hsl20_4_http_server.Server.set_address	(		self,
			ip,
			port
	)

Setzt die IP-Adresse und den IP-Port.

Parameter

ip	string IP-Adresse, an die der Server gebunden wird. Ein Leerstring bindet den Server an alle Netzwerk-Adressen des HS/FS.
port	int IP-Port, unter dem der Server erreichbar ist.

set_authentication()

def hsl20_4_http_server.hsl20_4_http_server.Server.set_authentication	(		self,
			user = None,
			pw = None,
			digest = False
	)

Setzt die HTTP-Authentifizierung:

• Werden beide Parameter übergeben, wird die HTTP-Authentifizierung aktiviert, ansonsten wird sie deaktiviert.

Die Authentifizierung zählt für alle registrierten URIs.

Parameter

user	string Benutzer
pw	string Passwort
digest	bool Optional. Wenn TRUE wird als Authenifizierungsmechanismus "Digest Access Authentication" verwendet, ansonsten "Basic Authentication".

Ab Version 2.0.3:

Parameter pw wird in der Doku nun korrekt angegeben

set_error_callback()

def hsl20_4_http_server.hsl20_4_http_server.Server.set_error_callback	(		self,
			callback
	)

Setzt eine Callback-Methode für den Fehlerfall.

Wird aufgerufen, wenn der Client eine nicht mit register_uri registrierte URL aufruft. Wird vom HTTP-Server nach Beenden dieser Methode ausgewertet.

Parameter

callback

function Die Callback-Methode benötigt folgende Parameter: errorcode int Fehlercode, der den aufgetretenen Fehler beschreibt. request string HTTP-Request-Objekt, das alle Informationen bezüglich des HTTP-Request zur Verfügung stellt. Wird vom HTTP-Server erzeugt. response string HTTP-Response-Objekt, das alle Informationen bezüglich des HTTP-Response enthalten muss.

set_logger()

def hsl20_4_http_server.hsl20_4_http_server.Server.set_logger	(		self,
			logger
	)

Weist dem Server eine hsl20_4.hsl20_4.Logger Instanz zu.

Parameter

logger

hsl20_4.Logger Logger-Objekt

set_max_post_size()

def hsl20_4_http_server.hsl20_4_http_server.Server.set_max_post_size	(		self,
			size
	)

Setzt die zulässige Größe des Body für POST/PUT-Aufrufe.

Wird der Wert überschritten, wird der Aufruf abgebrochen.

Standardwert: 1.000.000 Byte
Zulässiger Höchstwert (MAXWERT): 10.000.000 Byte

Parameter

size	int Größe in Byte. Ist size > MAXWERT wird size = MAXWERT gesetzt!

set_server_name()

def hsl20_4_http_server.hsl20_4_http_server.Server.set_server_name	(		self,
			name
	)

Setzt den Server-Name.

Wenn gesetzt, wird dieser Wert bei einem HTTP-Request als Standard-Wert für das Feld 'Server' verwendet. Der hier gesetzte Wert kann mit response.set_header überschrieben werden. Wenn kein Wert per set_server_name angegeben wird und kein Wert per response.set_header angegeben wird, wird der Context als Server-Name übermittelt.

Parameter

name	string Neuer Server-Name

start_server()

def hsl20_4_http_server.hsl20_4_http_server.Server.start_server

(

self

)

Startet den Server.

Ausnahmebehandlung

AttributeError

Wird ausgelöst, wenn keine gültige Adresse angegeben ist.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• hsl20_4_http_server.py